API Documentation
MAIN PAGE
NAMESPACES
CLASSES
Documentation
Headers
NilkinsAstraeus
Graphics
ComplexEffects
Dof
DofComplexEffect.h
1
// DofComplexEffect.h
3
//
5
6
namespace
nkAstraeus
7
{
16
class
DofComplexEffect
final :
public
ComplexEffect
17
{
18
public :
19
24
DofComplexEffect
(
const
nkMemory::StringView
& name) ;
29
~DofComplexEffect
() ;
30
31
// Getters
35
virtual
COMPLEX_EFFECT_TYPE
getType
()
const override
;
39
nkGraphics::Texture
*
getSourceTexture
()
const
;
43
nkGraphics::Texture
*
getSourceDepth
()
const
;
50
nkGraphics::Texture
*
getOutputTexture
()
const
;
54
nkGraphics::Camera
*
getCamera
()
const
;
58
float
getNearPlaneDistance
()
const
;
62
float
getFocalPlaneDistance
()
const
;
66
float
getFarPlaneDistance
()
const
;
70
unsigned
int
getBlurStrength
()
const
;
74
bool
getLinearDepth
()
const
;
75
76
// Setters
84
void
setSourceTexture
(
nkGraphics::Texture
* value) ;
92
void
setSourceDepth
(
nkGraphics::Texture
* value) ;
101
void
setCamera
(
nkGraphics::Camera
* value) ;
111
void
setNearPlaneDistance
(
float
value) ;
121
void
setFocalPlaneDistance
(
float
value) ;
131
void
setFarPlaneDistance
(
float
value) ;
141
void
setBlurStrength
(
unsigned
int
value) ;
152
void
setLinearDepth
(
bool
value) ;
153
154
// Load
158
virtual
bool
load
()
override
;
162
virtual
void
unload
()
override
;
163
} ;
164
}
nkAstraeus::COMPLEX_EFFECT_TYPE
COMPLEX_EFFECT_TYPE
Enumerates all complex effects available in the component.
Definition:
ComplexEffectType.h:12
nkAstraeus::DofComplexEffect::setSourceDepth
void setSourceDepth(nkGraphics::Texture *value)
nkAstraeus::DofComplexEffect::getBlurStrength
unsigned int getBlurStrength() const
nkGraphics::Camera
Offers all controls to model a camera.
Definition:
Camera.h:12
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition:
Texture.h:35
nkAstraeus::DofComplexEffect::getSourceDepth
nkGraphics::Texture * getSourceDepth() const
nkAstraeus::DofComplexEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkAstraeus::DofComplexEffect::getNearPlaneDistance
float getNearPlaneDistance() const
nkAstraeus::DofComplexEffect::getCamera
nkGraphics::Camera * getCamera() const
nkAstraeus::DofComplexEffect::setFarPlaneDistance
void setFarPlaneDistance(float value)
nkAstraeus::DofComplexEffect::getLinearDepth
bool getLinearDepth() const
nkAstraeus::DofComplexEffect::setLinearDepth
void setLinearDepth(bool value)
nkAstraeus::DofComplexEffect::getOutputTexture
nkGraphics::Texture * getOutputTexture() const
nkAstraeus::ComplexEffect
Base class for all complex effects in the component.
Definition:
ComplexEffect.h:18
nkAstraeus::DofComplexEffect::setNearPlaneDistance
void setNearPlaneDistance(float value)
nkAstraeus::DofComplexEffect::setBlurStrength
void setBlurStrength(unsigned int value)
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition:
Engine.h:7
nkAstraeus::DofComplexEffect
A Depth of Field effect.
Definition:
DofComplexEffect.h:17
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition:
StringView.h:22
nkAstraeus::DofComplexEffect::load
virtual bool load() override
nkAstraeus::DofComplexEffect::unload
virtual void unload() override
nkAstraeus::DofComplexEffect::getFarPlaneDistance
float getFarPlaneDistance() const
nkAstraeus::DofComplexEffect::DofComplexEffect
DofComplexEffect(const nkMemory::StringView &name)
nkAstraeus::DofComplexEffect::setCamera
void setCamera(nkGraphics::Camera *value)
nkAstraeus::DofComplexEffect::setFocalPlaneDistance
void setFocalPlaneDistance(float value)
nkAstraeus::DofComplexEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus::DofComplexEffect::getType
virtual COMPLEX_EFFECT_TYPE getType() const override
nkAstraeus::DofComplexEffect::getFocalPlaneDistance
float getFocalPlaneDistance() const
nkAstraeus::DofComplexEffect::~DofComplexEffect
~DofComplexEffect()
Generated by
Doxygen
1.8.18